Skip to content

feat(logger): documentation, examples, business logic changes #293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 9 commits into from
Dec 13, 2021
Merged

feat(logger): documentation, examples, business logic changes #293

merged 9 commits into from
Dec 13, 2021

Conversation

saragerion
Copy link
Contributor

Description of your changes

Updated mkdocs resources for logger module

How to verify this change

  1. build the doc with npm run docs-runLocalDocker
  2. go to http://localhost:8000/core/logger/

Related issues, RFCs

#130

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • Any dependent changes have been merged and published in downstream module
  • The PR title follows the conventional commit semantics

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@saragerion
Copy link
Contributor Author

There are a couple of things that are different from the python one, the following items are currently missing from this doc:

  • Logging incoming event - log_event param or via POWERTOOLS_LOGGER_LOG_EVENT
  • Setting a Correlation ID
  • correlation_id_path
  • !!! info "Custom keys are persisted across warm invocations"
  • location key in log
  • set_correlation_id method
  • Removing additional keys

  • Clearing all state

  • concept of logger name
  • Logging incoming event in the context

This is because either they were implemented after the business logic was done (will be added after the beta), or they don't fit the typescript ecosystem

@saragerion saragerion changed the title feat: logger mkdocs, small updates to logic and test for feature parity feat(logger): add mkdocs, small updates to logic and test for feature parity Dec 13, 2021
@saragerion saragerion changed the title feat(logger): add mkdocs, small updates to logic and test for feature parity feat(logger): edit mkdocs, small updates to logic and test for feature parity Dec 13, 2021
@dreamorosi dreamorosi added this to the beta-release milestone Dec 13, 2021
@dreamorosi dreamorosi added documentation Improvements or additions to documentation enhancement logger This item relates to the Logger Utility labels Dec 13, 2021
dreamorosi
dreamorosi previously approved these changes Dec 13, 2021
View reviewed changes
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

flochaz
flochaz suggested changes Dec 13, 2021
View reviewed changes
@saragerion @flochaz
Update docs/core/logger.md
2f19afa 
Co-authored-by: Florian Chazal <[email protected]>
saragerion and others added 7 commits December 13, 2021 12:06
@saragerion @flochaz
Update docs/core/logger.md
b09d859 
Co-authored-by: Florian Chazal <[email protected]>
@saragerion @flochaz
Update docs/core/logger.md
16123eb 
Co-authored-by: Florian Chazal <[email protected]>
@saragerion @flochaz
Update docs/core/logger.md
9c4ba92 
Co-authored-by: Florian Chazal <[email protected]>
@saragerion @flochaz
Update docs/core/logger.md
b3b42a7 
Co-authored-by: Florian Chazal <[email protected]>
@saragerion @flochaz
Update docs/core/logger.md
a7593f2 
Co-authored-by: Florian Chazal <[email protected]>
@saragerion @flochaz
Update docs/core/logger.md
c11b92e 
Co-authored-by: Florian Chazal <[email protected]>
@saragerion @flochaz
Update docs/core/logger.md
b115dfc 
Co-authored-by: Florian Chazal <[email protected]>
@saragerion saragerion linked an issue Dec 13, 2021 that may be closed by this pull request
Docs: Logger documentation #130
Closed
@saragerion saragerion requested a review from flochaz December 13, 2021 16:25
@saragerion saragerion merged commit 87cf8e6 into main Dec 13, 2021
@saragerion saragerion deleted the feature/logger-docs branch December 13, 2021 16:41
@saragerion saragerion changed the title feat(logger): edit mkdocs, small updates to logic and test for feature parity feat(logger): documentation, examples, business logic changes Dec 22, 2021
@saragerion saragerion mentioned this pull request Jan 18, 2022
Closed
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@flochaz flochaz flochaz approved these changes

@dreamorosi dreamorosi dreamorosi approved these changes

Assignees

@saragerion saragerion

Labels
documentation Improvements or additions to documentation logger This item relates to the Logger Utility
Projects
None yet
Milestone
beta-release
Development

Successfully merging this pull request may close these issues.

Docs: Logger documentation
3 participants
@saragerion @flochaz @dreamorosi